package com.yiduo.outpost.core.log.operation;

import com.yiduo.outpost.core.model.enums.Action;

import java.lang.annotation.*;

/**
 * 自定义操作日志记录注解
 *
 * @Author yanwen
 * @create 2024/1/6 15:33
 */
@Target({ElementType.PARAMETER, ElementType.METHOD}) // 注解放置的目标位置,PARAMETER: 可用在参数上  METHOD：可用在方法级别上
@Retention(RetentionPolicy.RUNTIME)    // 指明修饰的注解的生存周期  RUNTIME：运行级别保留
@Documented
public @interface OperationLog {

    /**
     * 模块
     */
    String title() default "";

    /**
     * 功能详细描述
     *
     * @return
     */
    String description() default "";

    Action action() default Action.UNKNOWN;

    /**
     * 是否保存请求的参数
     */
    public boolean isSaveRequestData() default true;

    /**
     * 是否保存响应的参数
     */
    public boolean isSaveResponseData() default true;
}
